Simplify newline handling of comment token in TokenStream#to_html #1532
+6
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The logic of newline handling to make html <span> tag pretty does not need to be restricted to comment token. Remove comment-specific condition and make it simple.
tompng
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
Collaborator
|
🚀 Preview deployment available at: https://64804086.rdoc-6cd.pages.dev (commit: a9c8214) |
kou
approved these changes
Dec 31, 2025
| "<span class=\"#{style}\">#{text}</span>#{"\n" if comment_with_nl}" | ||
| if text.end_with?("\n") | ||
| newline = "\n" | ||
| text = text.byteslice(0...-1) |
Member
There was a problem hiding this comment.
Can we use chomp or delete_suffix here?
Suggested change
| text = text.byteslice(0...-1) | |
| text = text.delete_suffix("\n") |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The logic of newline handling to make html
<span>tag pretty does not need to be restricted to comment token.Remove comment-specific condition and make it simple.
What this code is doing
Moves trailing
"\n"outside of closing</span>tag to make generated HTML pretty.↓
Background
In most case, only
:on_commenttoken (and weird percent literal string token) might end with"\n"becauseRDoc::Parser::Rubyhas token-squashing.I'm writing a new syntax highlighter for RDoc and want to make this pretty-html generation applied to other tokens too.
Removing token-squashing will generate more tokens that ends with
"\n".